Autogenerated HTML docs for v2.0.0-390-gcb682
diff --git a/technical/api-argv-array.html b/technical/api-argv-array.html index 8ea0f81..dffe190 100644 --- a/technical/api-argv-array.html +++ b/technical/api-argv-array.html
@@ -831,24 +831,6 @@ initial, empty state. </p> </dd> -<dt class="hdlist1"> -<tt>argv_array_detach</tt> -</dt> -<dd> -<p> - Detach the argv array from the <tt>struct argv_array</tt>, transferring - ownership of the allocated array and strings. -</p> -</dd> -<dt class="hdlist1"> -<tt>argv_array_free_detached</tt> -</dt> -<dd> -<p> - Free the memory allocated by a <tt>struct argv_array</tt> that was later - detached and is now no longer needed. -</p> -</dd> </dl></div> </div> </div> @@ -856,7 +838,7 @@ <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2013-08-20 08:40:27 PDT +Last updated 2014-06-16 14:13:22 PDT </div> </div> </body>
diff --git a/technical/api-argv-array.txt b/technical/api-argv-array.txt index a6b7d83..1a79781 100644 --- a/technical/api-argv-array.txt +++ b/technical/api-argv-array.txt
@@ -53,11 +53,3 @@ `argv_array_clear`:: Free all memory associated with the array and return it to the initial, empty state. - -`argv_array_detach`:: - Detach the argv array from the `struct argv_array`, transferring - ownership of the allocated array and strings. - -`argv_array_free_detached`:: - Free the memory allocated by a `struct argv_array` that was later - detached and is now no longer needed.
diff --git a/technical/api-run-command.html b/technical/api-run-command.html index 1869025..e9b94d7 100644 --- a/technical/api-run-command.html +++ b/technical/api-run-command.html
@@ -919,6 +919,12 @@ terminated), of which .argv[0] is the program name to run (usually without a path). If the command to run is a git command, set argv[0] to the command name without the <em>git-</em> prefix and set .git_cmd = 1.</p></div> +<div class="paragraph"><p>Note that the ownership of the memory pointed to by .argv stays with the +caller, but it should survive until <tt>finish_command</tt> completes. If the +.argv member is NULL, <tt>start_command</tt> will point it at the .args +<tt>argv_array</tt> (so you may use one or the other, but you must use exactly +one). The memory in .args will be cleaned up automatically during +<tt>finish_command</tt> (or during <tt>start_command</tt> when it is unsuccessful).</p></div> <div class="paragraph"><p>The members .in, .out, .err are used to redirect stdin, stdout, stderr as follows:</p></div> <div class="olist arabic"><ol class="arabic"> @@ -1153,7 +1159,7 @@ <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2013-08-20 08:40:27 PDT +Last updated 2014-06-16 14:13:22 PDT </div> </div> </body>
diff --git a/technical/api-run-command.txt b/technical/api-run-command.txt index 5d7d7f2..69510ae 100644 --- a/technical/api-run-command.txt +++ b/technical/api-run-command.txt
@@ -109,6 +109,13 @@ without a path). If the command to run is a git command, set argv[0] to the command name without the 'git-' prefix and set .git_cmd = 1. +Note that the ownership of the memory pointed to by .argv stays with the +caller, but it should survive until `finish_command` completes. If the +.argv member is NULL, `start_command` will point it at the .args +`argv_array` (so you may use one or the other, but you must use exactly +one). The memory in .args will be cleaned up automatically during +`finish_command` (or during `start_command` when it is unsuccessful). + The members .in, .out, .err are used to redirect stdin, stdout, stderr as follows:
diff --git a/technical/api-strbuf.html b/technical/api-strbuf.html index ab2d13c..9747660 100644 --- a/technical/api-strbuf.html +++ b/technical/api-strbuf.html
@@ -970,6 +970,23 @@ </p> </dd> <dt class="hdlist1"> +<tt>strbuf_reencode</tt> +</dt> +<dd> +<p> + Replace the contents of the strbuf with a reencoded form. Returns -1 + on error, 0 on success. +</p> +</dd> +<dt class="hdlist1"> +<tt>strbuf_tolower</tt> +</dt> +<dd> +<p> + Lowercase each character in the buffer using <tt>tolower</tt>. +</p> +</dd> +<dt class="hdlist1"> <tt>strbuf_cmp</tt> </dt> <dd> @@ -1303,7 +1320,7 @@ <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2014-06-03 15:14:46 PDT +Last updated 2014-06-16 14:13:22 PDT </div> </div> </body>
diff --git a/technical/api-strbuf.txt b/technical/api-strbuf.txt index 4396be9..077a709 100644 --- a/technical/api-strbuf.txt +++ b/technical/api-strbuf.txt
@@ -134,6 +134,15 @@ Strip whitespace from the beginning of a string. +`strbuf_reencode`:: + + Replace the contents of the strbuf with a reencoded form. Returns -1 + on error, 0 on success. + +`strbuf_tolower`:: + + Lowercase each character in the buffer using `tolower`. + `strbuf_cmp`:: Compare two buffers. Returns an integer less than, equal to, or greater
diff --git a/technical/api-string-list.html b/technical/api-string-list.html index d03912d..ee813fa 100644 --- a/technical/api-string-list.html +++ b/technical/api-string-list.html
@@ -1073,6 +1073,12 @@ before adding them, see above. </p> </li> +<li> +<p> +The <tt>compare_strings_fn</tt> member is used to specify a custom compare + function, otherwise <tt>strcmp()</tt> is used as the default function. +</p> +</li> </ol></div> </div> </div> @@ -1080,7 +1086,7 @@ <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2013-08-20 08:40:27 PDT +Last updated 2014-06-16 14:13:22 PDT </div> </div> </body>
diff --git a/technical/api-string-list.txt b/technical/api-string-list.txt index 20be348..f1add51 100644 --- a/technical/api-string-list.txt +++ b/technical/api-string-list.txt
@@ -200,3 +200,5 @@ You should not tamper with it. . Setting the `strdup_strings` member to 1 will strdup() the strings before adding them, see above. +. The `compare_strings_fn` member is used to specify a custom compare + function, otherwise `strcmp()` is used as the default function.
